home *** CD-ROM | disk | FTP | other *** search
/ Suzy B Software 2 / Suzy B Software CD-ROM 2 (1994).iso / extras / picmanip / spoflt38 / readme / scripts.doc < prev    next >
Encoding:
Text File  |  1995-04-27  |  6.3 KB  |  163 lines
  1. ------------------------------------------------
  2. --- SCRIPT COMMAND FILES (.SLS)              ---
  3. --- FOR SPEED OF LIGHT VERSION 3.7 AND AFTER ---
  4. ------------------------------------------------
  5.  
  6. Complete information on how to create and run your own SOL script files!
  7.  
  8. This documentation is (c) Copyright 1994, Stuart Denman.
  9.  
  10.  
  11. ----------------------------------------------------------
  12. --==>> WHAT IS A SPEED of LIGHT SCRIPT (.SLS) FILE? <<==--
  13. ----------------------------------------------------------
  14.  
  15. A script file is simply a ASCII text file that contains commands.  These
  16. files are executed like a simple programming language.  All you need to
  17. make your own is any ASCII text editor or word processor than can save in
  18. ASCII text format.  You can also let SOL make them for you by recording 
  19. them from within the SOL slideshow dialog, but this feature is described 
  20. at the end of this document.
  21.  
  22. Each line of an .SLS file contains either a comment, a command, or a
  23. filename.  A comment line always has a '#' character at the beginning of
  24. the line followed by text.  Blank lines do NOT need to be started by a '#'
  25. character.  A command line begins with a forward slash '/' character,
  26. followed by the command.  All commands are described in detail below.
  27. You can also put a filename on a line to tell SOL to load in that
  28. filename and display it.
  29.  
  30. Filenames are typed out without any special characters before them.  You 
  31. can either type out the full path and drive letter, or just the 
  32. filename.  If you only put the filename, that file must be located 
  33. in the same directory as the script file.  You can also use wildcards 
  34. (*,?) in your filename which will cause SOL to load in all files that 
  35. fit that wildcard, displaying each one in turn.  By default, each file 
  36. that is loaded in will replace the previous file in memory, unless you 
  37. use the /ADD command (see below.)
  38.  
  39. Each filename can be followed by a integral number which indicates how
  40. many seconds to display the image before executing the next script
  41. command.  If you do not include a number here, then the image will be
  42. displayed for the number of seconds that the last image was displayed
  43. for.  If there was no number specified in the script file, SOL will use
  44. the display time set in the Slideshow Settings Dialog Box.
  45.  
  46.  
  47. -----------------------------
  48. --==>> SCRIPT COMMANDS <<==--
  49. -----------------------------
  50.  
  51. Each commands starts with a forward slash '/' character.  You can only
  52. have one command and its parameters per line.  Case is ignored in the
  53. commands (i.e. /ADD = /add = /Add).  Some commands take parameters, and
  54. some allow you to omit parameters.  Omitting some parameters will leave
  55. them unchanged from their previous settings.  The first parameter must
  56. ALWAYS be included in a command that takes parameters and omitted 
  57. parameters must be at the end of the list.  Each parameter is separated 
  58. by one space character.
  59.  
  60. Any errors in the commands found before execution begins (while loading
  61. in the script file) will be indicated to you and the script file will
  62. abort.  Errors found while running the script will cause an alert box
  63. that will ask you whether you want to continue executing the other
  64. commands in the script or not.
  65.  
  66. NOTE that most commands will alter settings and preferences in SOL.
  67.  
  68. /FIT         - Sets the "Fit image to screen on load" preference.
  69.  
  70. /NOFIT       - Turns off fitting.
  71.  
  72. /SCALE x y   - Scales the next image to the width and height specified
  73.                in the 'x' and 'y' parameters.
  74.  
  75. /CLIP x y w h  - Clips the next image.
  76.  
  77. /POS x y     - Positions the upper left-hand corner of the display for
  78.                the next image.
  79.  
  80. /HFLIP       - Flips the next image horizontally.
  81.  
  82. /VFLIP       - Flips the next image vertically.
  83.  
  84. /ROTR        - Rotates the next image 90 degrees right.
  85.  
  86. /ROTL        - Rotates the next image 90 degrees left.
  87.  
  88. /ADD         - Tells SOL to keep the next image it loads in memory instead
  89.                of purging it after display.  If /ADD is not before an image
  90.                then it will be purged before the next image is loaded.
  91.  
  92. /COLOR       - Sets the display mode to color.
  93.  
  94. /SHADES      - Sets the display mode to shades.
  95.  
  96. /DRAW        - Shows drawing of the image.
  97.  
  98. /NODRAW      - Blanks the screen while drawing.
  99.  
  100. /MOUSE       - Leaves mouse on while displaying image.
  101.  
  102. /NOMOUSE     - Turns mouse off.
  103.  
  104. /TCLOAD x    - Selects the type of truecolor conversion:
  105.                0=Octree , 1=Fixed, 2=Greyscale
  106.  
  107. /FIXPAL x    - Selects the type of fixed palette used:
  108.                0=Red, 1=Green, 2=Blue,
  109.                3=Red-Green, 4=Red-Blue, 5=Green-Blue
  110.  
  111. /WARP p r x y w h  - Sets the warping parameters (same as in dialog):
  112.                       p - the wave pattern 0=off,1=Flat,2=Linear,etc.
  113.                       r - repeat 0=single,1=periodic
  114.                       x - the shift right or left of the wave (+/-)
  115.                       y - the position in the image of the wave
  116.                       w - the width of the wave (+/-)
  117.                       h - the height of the wave
  118.  
  119. /SHOW        - Displays the "progress" dialogs when the next image loads
  120.                in instead of working in the background.
  121.  
  122. /NOSHOW      - Does all loading and processing of the next image in the
  123.                background so you can view the last image while SOL works.
  124.  
  125. /STOP        - Stop executing the script.  Same as just an end of file.
  126.  
  127.  
  128.  
  129.  
  130. ----------------------------------
  131. --==>> EXAMPLE SCRIPT FILE: <<==--
  132. ----------------------------------
  133.  
  134. /clip 100 100 150 200
  135. # This picture must be in the same directory as this .SLS file.
  136. # Displays for the default display time.
  137. PICTURE1.GIF
  138.  
  139. /ROTR
  140. # These have a path.  First one displays for 20 seconds.
  141. D:\GRAPHICS\JPEG\FROGS.JPG 20
  142.  
  143. /ADD
  144. /SCALE 320 200
  145. # This displays for 30 sec.
  146. D:\GRAPHICS\IMAGE\PICTURE2.IMG 30
  147.  
  148. /hflip
  149. /WARP 3 0
  150. # This also displays for 30 sec.  Since /ADD was used for the PREVIOUS
  151. # image, this image will NOT replace PICTURE2.IMG.
  152. PICTURE3.PNT
  153.  
  154. /WARP 0
  155. # We must turn off warping since it effects all images after it is executed.
  156.  
  157. # This causes SOL to stop executing this script file and to continue with
  158. # the file ABS.SLS.  You can also use the name of the current script to
  159. # execute the same one over and over again.
  160. ABC.SLS
  161.  
  162.  
  163.